<a name="COSA"></a>
## COSA : <code>object</code>
**Kind**: global namespace  

* [COSA](#COSA) : <code>object</code>
    * [.EntityCollection](#COSA.EntityCollection)
    * [.OrderExpression](#COSA.OrderExpression)
    * [.PageInfo](#COSA.PageInfo)
    * [.QueryExpression](#COSA.QueryExpression)
    * [.ConditionExpression](#COSA.ConditionExpression)
    * [.FilterExpression](#COSA.FilterExpression)
    * [.LinkEntity](#COSA.LinkEntity)
    * [.XrmString](#COSA.XrmString)
    * [.XrmDateTime](#COSA.XrmDateTime)
    * [.XrmWholeNumber](#COSA.XrmWholeNumber)
    * [.XrmBoolean](#COSA.XrmBoolean)
    * [.XrmDouble](#COSA.XrmDouble)
    * [.XrmGuid](#COSA.XrmGuid)
    * [.XrmDecimal](#COSA.XrmDecimal)
    * [.EntityFilters](#COSA.EntityFilters)
    * [.XrmMoney](#COSA.XrmMoney)
    * [.OptionSetValue](#COSA.OptionSetValue)
    * [.Relationship](#COSA.Relationship)
    * [.BusinessEntity](#COSA.BusinessEntity)
    * [.EntityReference](#COSA.EntityReference)
    * [.ExecuteMultipleSettings](#COSA.ExecuteMultipleSettings)
    * [.DeletedMetadataFilters](#COSA.DeletedMetadataFilters)
    * [.Const](#COSA.Const) : <code>object</code>
        * [.AttributeType](#COSA.Const.AttributeType) : <code>enum</code>
        * [.FilterOperator](#COSA.Const.FilterOperator) : <code>enum</code>
        * [.JoinOperator](#COSA.Const.JoinOperator) : <code>enum</code>
        * [.OrderType](#COSA.Const.OrderType) : <code>enum</code>
        * [.ConditionOperator](#COSA.Const.ConditionOperator) : <code>enum</code>
        * [.EntityFilters](#COSA.Const.EntityFilters) : <code>enum</code>
        * [.KeyValuePairType](#COSA.Const.KeyValuePairType) : <code>enum</code>
        * [.EntityRole](#COSA.Const.EntityRole) : <code>enum</code>
        * [.MetadataConditionOperator](#COSA.Const.MetadataConditionOperator) : <code>enum</code>
        * [.DeletedMetadataFilters](#COSA.Const.DeletedMetadataFilters) : <code>enum</code>
        * [.AttributeRequiredLevel](#COSA.Const.AttributeRequiredLevel) : <code>enum</code>
        * [.DateTimeFormat](#COSA.Const.DateTimeFormat) : <code>enum</code>
        * [.ImeMode](#COSA.Const.ImeMode) : <code>enum</code>
        * [.IntegerFormat](#COSA.Const.IntegerFormat) : <code>enum</code>
        * [.OwnershipType](#COSA.Const.OwnershipType) : <code>enum</code>
        * [.RelationshipType](#COSA.Const.RelationshipType) : <code>enum</code>
        * [.StringFormat](#COSA.Const.StringFormat) : <code>enum</code>
    * [.Response](#COSA.Response) : <code>object</code>
        * [.ExecuteWorkflow](#COSA.Response.ExecuteWorkflow)
        * [.Assign](#COSA.Response.Assign)
        * [.SetState](#COSA.Response.SetState)
        * [.LoseOpportunity](#COSA.Response.LoseOpportunity)
        * [.WinOpportunity](#COSA.Response.WinOpportunity)
        * [.AddListMembersList](#COSA.Response.AddListMembersList)
        * [.AddMemberList](#COSA.Response.AddMemberList)
        * [.CopyMembersList](#COSA.Response.CopyMembersList)
        * [.RemoveMemberList](#COSA.Response.RemoveMemberList)
        * [.RetrieveUserPrivileges](#COSA.Response.RetrieveUserPrivileges)
        * [.RetrievePrincipalAccess](#COSA.Response.RetrievePrincipalAccess)
        * [.QualifyLead](#COSA.Response.QualifyLead)
        * [.Retrieve](#COSA.Response.Retrieve)
        * [.RetrieveMultiple](#COSA.Response.RetrieveMultiple)
        * [.Create](#COSA.Response.Create)
        * [.Update](#COSA.Response.Update)
        * [.ExecuteMultiple](#COSA.Response.ExecuteMultiple)
        * [.Delete](#COSA.Response.Delete)
        * [.Associate](#COSA.Response.Associate)
        * [.Disassociate](#COSA.Response.Disassociate)
        * [.RetrieveAttribute](#COSA.Response.RetrieveAttribute)
        * [.RetrieveEntity](#COSA.Response.RetrieveEntity)
        * [.RetrieveAllEntities](#COSA.Response.RetrieveAllEntities)
        * [.RetrieveMetadataChanges](#COSA.Response.RetrieveMetadataChanges)
    * [.Request](#COSA.Request) : <code>object</code>
        * [.ExecuteWorkflow](#COSA.Request.ExecuteWorkflow)
        * [.Assign](#COSA.Request.Assign)
        * [.SetState](#COSA.Request.SetState)
        * [.RetrieveUserPrivileges](#COSA.Request.RetrieveUserPrivileges)
        * [.RetrievePrincipalAccess](#COSA.Request.RetrievePrincipalAccess)
        * [.LoseOpportunity](#COSA.Request.LoseOpportunity)
        * [.WinOpportunity](#COSA.Request.WinOpportunity)
        * [.QualifyLead](#COSA.Request.QualifyLead)
        * [.AddListMembersList](#COSA.Request.AddListMembersList)
        * [.AddMemberList](#COSA.Request.AddMemberList)
        * [.CopyMembersList](#COSA.Request.CopyMembersList)
        * [.RemoveMemberList](#COSA.Request.RemoveMemberList)
        * [.Retrieve](#COSA.Request.Retrieve)
        * [.Create](#COSA.Request.Create)
        * [.Update](#COSA.Request.Update)
        * [.Delete](#COSA.Request.Delete)
        * [.ExecuteMultiple](#COSA.Request.ExecuteMultiple)
        * [.RetrieveMultiple](#COSA.Request.RetrieveMultiple)
        * [.RetrieveAttribute](#COSA.Request.RetrieveAttribute)
        * [.RetrieveEntity](#COSA.Request.RetrieveEntity)
        * [.RetrieveAllEntities](#COSA.Request.RetrieveAllEntities)
        * [.Associate](#COSA.Request.Associate)
        * [.Disassociate](#COSA.Request.Disassociate)
        * [.RetrieveMetadataChanges](#COSA.Request.RetrieveMetadataChanges)

<a name="COSA.EntityCollection"></a>
### COSA.EntityCollection
EntityCollection

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| items | <code>[Array.&lt;BusinessEntity&gt;](#COSA.BusinessEntity)</code> | Initial items |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| entityName | <code>string</code> | Entity logical name |
| minActiveRowVersion | <code>number</code> | Min active row version |
| moreRecords | <code>boolean</code> | More records |
| pagingCookie | <code>string</code> | Paging cookie |
| totalRecordCount | <code>number</code> | Total Record Count |
| totalRecordCountLimitExceeded | <code>boolean</code> | Total record count limit exceeded |

<a name="COSA.OrderExpression"></a>
### COSA.OrderExpression
Order Expression

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| attributeName | <code>string</code> | Attribute Logical Name |
| orderType | <code>[OrderType](#COSA.Const.OrderType)</code> | Order Type |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| attributeName | <code>string</code> | Attribute Logical Name |
| orderType | <code>[OrderType](#COSA.Const.OrderType)</code> |  |

<a name="COSA.PageInfo"></a>
### COSA.PageInfo
PageInfo

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| pagingCookie | <code>string</code> | Paging cookie |
| returnTotalRecordCount | <code>boolean</code> | Return total record count |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| count | <code>number</code> | Count |
| pageNumber | <code>number</code> | Page number |
| pagingCookie | <code>string</code> | Paging cookie |
| returnTotalRecordCount | <code>boolean</code> | Return total record count |

<a name="COSA.QueryExpression"></a>
### COSA.QueryExpression
QueryExpression

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| entityLogicalName | <code>string</code> | Entity logical name |
| columnSet | <code>COSA.ColumnSet</code> |  |
| criteria | <code>[FilterExpression](#COSA.FilterExpression)</code> | Filter expression |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| entityLogicalName | <code>string</code> | Entity logical name |
| columnSet | <code>COSA.ColumnSet</code> | Column set |
| criteria | <code>[FilterExpression](#COSA.FilterExpression)</code> | Filter expression |
| distinct | <code>boolean</code> | Distinct |
| linkEntities | <code>[Array.&lt;LinkEntity&gt;](#COSA.LinkEntity)</code> | Link entities |
| orders | <code>[Array.&lt;OrderExpression&gt;](#COSA.OrderExpression)</code> | Orders |
| noLock | <code>boolean</code> | No lock |
| pageInfo | <code>[PageInfo](#COSA.PageInfo)</code> | Page info |

<a name="COSA.ConditionExpression"></a>
### COSA.ConditionExpression
ConditionExpression

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| attributeName | <code>string</code> | Attribute logical name |
| operator | <code>[ConditionOperator](#COSA.Const.ConditionOperator)</code> | Condition Operator |
| values |  | Values |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| attributeName | <code>string</code> | Attribute logical name |
| operator | <code>[ConditionOperator](#COSA.Const.ConditionOperator)</code> | Condition Operator |
| values |  | Values |

<a name="COSA.FilterExpression"></a>
### COSA.FilterExpression
Filter expression

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| filterOperator | <code>[FilterOperator](#COSA.Const.FilterOperator)</code> | Filter operator |
| conditions | <code>[Array.&lt;ConditionExpression&gt;](#COSA.ConditionExpression)</code> | Conditions |
| filters | <code>[Array.&lt;FilterExpression&gt;](#COSA.FilterExpression)</code> | Filters |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| filterOperator | <code>[FilterOperator](#COSA.Const.FilterOperator)</code> | Filter operator |
| conditions | <code>[Array.&lt;ConditionExpression&gt;](#COSA.ConditionExpression)</code> | Conditions |
| filters | <code>[Array.&lt;FilterExpression&gt;](#COSA.FilterExpression)</code> | Filters |

<a name="COSA.LinkEntity"></a>
### COSA.LinkEntity
LinkEntity

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| initials | <code>object</code> | Initial values |
| initials.columns | <code>COSA.ColumnSet</code> | Columns |
| initials.entityAlias | <code>string</code> | Entity Alias |
| initials.joinOperator | <code>[JoinOperator](#COSA.Const.JoinOperator)</code> | Join operator |
| initials.linkCriteria | <code>[FilterExpression](#COSA.FilterExpression)</code> | Link Criteria |
| initials.linkEntities | <code>[Array.&lt;LinkEntity&gt;](#COSA.LinkEntity)</code> | Link entities |
| initials.linkFromAttributeName | <code>string</code> | Link from attribute name |
| initials.linkToAttributeName | <code>string</code> | Link to attribute name |
| initials.linkFromEntityName | <code>string</code> | Link from entity name |
| initials.linkToEntityName | <code>string</code> | Link to entity name |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| columns | <code>COSA.ColumnSet</code> | Columns |
| entityAlias | <code>string</code> | Entity Alias |
| joinOperator | <code>[JoinOperator](#COSA.Const.JoinOperator)</code> | Join operator |
| linkCriteria | <code>[FilterExpression](#COSA.FilterExpression)</code> | Link Criteria |
| linkEntities | <code>[Array.&lt;LinkEntity&gt;](#COSA.LinkEntity)</code> | Link entities |
| linkFromAttributeName | <code>string</code> | Link from attribute name |
| linkToAttributeName | <code>string</code> | Link to attribute name |
| linkFromEntityName | <code>string</code> | Link from entity name |
| linkToEntityName | <code>string</code> | Link to entity name |

<a name="COSA.XrmString"></a>
### COSA.XrmString
Contains data that is needed for 'string' type representation in CRM OrganizationRequest

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>string</code> | String value |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| value | <code>string</code> | String value |

<a name="COSA.XrmDateTime"></a>
### COSA.XrmDateTime
Contains data that is needed for 'DateTime' type representation in CRM OrganizationRequest

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>Date</code> | Date value |
| formattedValue | <code>string</code> | Formatted values |

<a name="COSA.XrmWholeNumber"></a>
### COSA.XrmWholeNumber
Contains data that is needed for 'WholeNumber' type representation in CRM OrganizationRequest

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>number</code> | Whole number value |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| value | <code>number</code> | Whole number value |

<a name="COSA.XrmBoolean"></a>
### COSA.XrmBoolean
Contains data that is needed for 'WholeNumber' type representation in CRM OrganizationRequest

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>boolean</code> | Boolean value |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| value | <code>boolean</code> | Boolean value |

<a name="COSA.XrmDouble"></a>
### COSA.XrmDouble
Contains data that is needed for 'XrmDouble' type representation in CRM OrganizationRequest

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type |
| --- | --- |
| value | <code>number</code> | 

**Properties**

| Name | Type |
| --- | --- |
| value | <code>number</code> | 

<a name="COSA.XrmGuid"></a>
### COSA.XrmGuid
Contains data that is needed for 'GUID' type representation in CRM OrganizationRequest

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| guidStr | <code>string</code> | GUID string |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| value | <code>string</code> | GUID string |

<a name="COSA.XrmDecimal"></a>
### COSA.XrmDecimal
Contains data that is needed for 'Decimal' type representation in CRM OrganizationRequest

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>number</code> | Decimal value |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| value | <code>number</code> | Decimal value |

<a name="COSA.EntityFilters"></a>
### COSA.EntityFilters
Entity filters

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| filtersString | <code>string</code> | Filters value |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| value | <code>string</code> | Filters value |

<a name="COSA.XrmMoney"></a>
### COSA.XrmMoney
Money

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>number</code> | Money value |
| formattedValue | <code>string</code> | Formatted value |

<a name="COSA.OptionSetValue"></a>
### COSA.OptionSetValue
OptionSetValue

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>number</code> | OptionSetValue |
| formattedValue | <code>string</code> | OptionSet formatted value |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| value | <code>number</code> | OptionSetValue |
| formattedValue | <code>string</code> | Formatted OptionSet value |

<a name="COSA.Relationship"></a>
### COSA.Relationship
Relationship

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| schemaName | <code>string</code> | Schema name |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| schemaName | <code>string</code> | Schema name |
| primaryEntityRole | <code>string</code> | Primary Entity Role |

<a name="COSA.BusinessEntity"></a>
### COSA.BusinessEntity
CRM Entity

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| logicalName | <code>string</code> | Entity logical name |
| id | <code>string</code> | Guid-like string as Entity unique identifier |
| attributes | <code>object</code> | Entity attributes |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | Entity unique identifier |
| logicalName | <code>string</code> | Entity logical name |
| attributes | <code>object</code> | Entity attributes |

<a name="COSA.EntityReference"></a>
### COSA.EntityReference
EntityReference

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| logicalName | <code>string</code> | Entity Logical Name |
| id | <code>string</code> | Entity unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| logicalName | <code>string</code> | Entity Logical Name |
| id | <code>string</code> | Entity unique identifier (GUID) |
| name | <code>string</code> | Formatted value |

<a name="COSA.ExecuteMultipleSettings"></a>
### COSA.ExecuteMultipleSettings
Execute multiple settings

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| continueOnError | <code>boolean</code> | Continue On Error |
| returnResponses | <code>boolean</code> | Return responses |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| continueOnError | <code>boolean</code> | Continue On Error |
| returnResponses | <code>boolean</code> | Return responses |

<a name="COSA.DeletedMetadataFilters"></a>
### COSA.DeletedMetadataFilters
DeleteMetadataFilters

**Kind**: static class of <code>[COSA](#COSA)</code>  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>string</code> | Value |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| value | <code>string</code> | Value |

<a name="COSA.Const"></a>
### COSA.Const : <code>object</code>
**Kind**: static namespace of <code>[COSA](#COSA)</code>  

* [.Const](#COSA.Const) : <code>object</code>
    * [.AttributeType](#COSA.Const.AttributeType) : <code>enum</code>
    * [.FilterOperator](#COSA.Const.FilterOperator) : <code>enum</code>
    * [.JoinOperator](#COSA.Const.JoinOperator) : <code>enum</code>
    * [.OrderType](#COSA.Const.OrderType) : <code>enum</code>
    * [.ConditionOperator](#COSA.Const.ConditionOperator) : <code>enum</code>
    * [.EntityFilters](#COSA.Const.EntityFilters) : <code>enum</code>
    * [.KeyValuePairType](#COSA.Const.KeyValuePairType) : <code>enum</code>
    * [.EntityRole](#COSA.Const.EntityRole) : <code>enum</code>
    * [.MetadataConditionOperator](#COSA.Const.MetadataConditionOperator) : <code>enum</code>
    * [.DeletedMetadataFilters](#COSA.Const.DeletedMetadataFilters) : <code>enum</code>
    * [.AttributeRequiredLevel](#COSA.Const.AttributeRequiredLevel) : <code>enum</code>
    * [.DateTimeFormat](#COSA.Const.DateTimeFormat) : <code>enum</code>
    * [.ImeMode](#COSA.Const.ImeMode) : <code>enum</code>
    * [.IntegerFormat](#COSA.Const.IntegerFormat) : <code>enum</code>
    * [.OwnershipType](#COSA.Const.OwnershipType) : <code>enum</code>
    * [.RelationshipType](#COSA.Const.RelationshipType) : <code>enum</code>
    * [.StringFormat](#COSA.Const.StringFormat) : <code>enum</code>

<a name="COSA.Const.AttributeType"></a>
#### Const.AttributeType : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| String | <code>string</code> | <code>&quot;string&quot;</code> | 
| WholeNumber | <code>string</code> | <code>&quot;int&quot;</code> | 
| FloatingPointNumber | <code>string</code> | <code>&quot;double&quot;</code> | 
| Decimal | <code>string</code> | <code>&quot;decimal&quot;</code> | 
| DateTime | <code>string</code> | <code>&quot;dateTime&quot;</code> | 
| TwoOption | <code>string</code> | <code>&quot;boolean&quot;</code> | 
| Image | <code>string</code> | <code>&quot;base64Binary&quot;</code> | 
| OptionSet | <code>string</code> | <code>&quot;OptionSet&quot;</code> | 
| Bool | <code>string</code> | <code>&quot;boolean&quot;</code> | 
| Currency | <code>string</code> | <code>&quot;Money&quot;</code> | 
| EntityReference | <code>string</code> | <code>&quot;EntityReference&quot;</code> | 
| ActivityParty | <code>string</code> | <code>&quot;EntityCollection&quot;</code> | 
| EntityCollection | <code>string</code> | <code>&quot;EntityCollection&quot;</code> | 
| Entity | <code>string</code> | <code>&quot;BusinessEntity&quot;</code> | 
| GUID | <code>string</code> | <code>&quot;guid&quot;</code> | 
| Number | <code>string</code> | <code>&quot;number&quot;</code> | 
| EntityFilters | <code>string</code> | <code>&quot;EntityFilters&quot;</code> | 

<a name="COSA.Const.FilterOperator"></a>
#### Const.FilterOperator : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| AND | <code>string</code> | <code>&quot;And&quot;</code> | 
| OR | <code>string</code> | <code>&quot;Or&quot;</code> | 

<a name="COSA.Const.JoinOperator"></a>
#### Const.JoinOperator : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| Inner | <code>string</code> | <code>&quot;Inner&quot;</code> | 
| LeftOuter | <code>string</code> | <code>&quot;LeftOuter&quot;</code> | 
| Natural | <code>string</code> | <code>&quot;Natural&quot;</code> | 

<a name="COSA.Const.OrderType"></a>
#### Const.OrderType : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| Asc | <code>string</code> | <code>&quot;Ascending&quot;</code> | 
| Desc | <code>string</code> | <code>&quot;Descending&quot;</code> | 

<a name="COSA.Const.ConditionOperator"></a>
#### Const.ConditionOperator : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| Like | <code>string</code> | <code>&quot;Like&quot;</code> | 
| BeginsWith | <code>string</code> | <code>&quot;BeginsWith&quot;</code> | 
| Between | <code>string</code> | <code>&quot;Between&quot;</code> | 
| ChildOf | <code>string</code> | <code>&quot;ChildOf&quot;</code> | 
| Contains | <code>string</code> | <code>&quot;Contains&quot;</code> | 
| DoesNotBeginWith | <code>string</code> | <code>&quot;DoesNotBeginWith&quot;</code> | 
| DoesNotContain | <code>string</code> | <code>&quot;DoesNotContain&quot;</code> | 
| DoesNotEndWith | <code>string</code> | <code>&quot;DoesNotEndWith&quot;</code> | 
| Equal | <code>string</code> | <code>&quot;Equal&quot;</code> | 
| EqualBusinessId | <code>string</code> | <code>&quot;EqualBusinessId&quot;</code> | 
| EqualUserId | <code>string</code> | <code>&quot;EqualUserId&quot;</code> | 
| EqualUserLanguage | <code>string</code> | <code>&quot;EqualUserLanguage&quot;</code> | 
| EqualUserOrUserTeams | <code>string</code> | <code>&quot;EqualUserOrUserTeams&quot;</code> | 
| EqualUserTeams | <code>string</code> | <code>&quot;EqualUserTeams&quot;</code> | 
| EndsWith | <code>string</code> | <code>&quot;EndsWith&quot;</code> | 
| InOrAfterFiscalPeriodAndYear | <code>string</code> | <code>&quot;InOrAfterFiscalPeriodAndYear&quot;</code> | 
| InOrBeforeFiscalPeriodAndYear | <code>string</code> | <code>&quot;InOrBeforeFiscalPeriodAndYear&quot;</code> | 
| In | <code>string</code> | <code>&quot;In&quot;</code> | 
| InFiscalPeriod | <code>string</code> | <code>&quot;InFiscalPeriod&quot;</code> | 
| InFiscalPeriodAndYear | <code>string</code> | <code>&quot;InFiscalPeriodAndYear&quot;</code> | 
| InFiscalYear | <code>string</code> | <code>&quot;InFiscalYear&quot;</code> | 
| Last7Days | <code>string</code> | <code>&quot;Last7Days&quot;</code> | 
| LastMonth | <code>string</code> | <code>&quot;LastMonth&quot;</code> | 
| LastWeek | <code>string</code> | <code>&quot;LastWeek&quot;</code> | 
| LastXDays | <code>string</code> | <code>&quot;LastXDays&quot;</code> | 
| LastXFiscalPeriods | <code>string</code> | <code>&quot;LastXFiscalPeriods&quot;</code> | 
| LastXFiscalYears | <code>string</code> | <code>&quot;LastXFiscalYears&quot;</code> | 
| LastXHours | <code>string</code> | <code>&quot;LastXHours&quot;</code> | 
| LastXMonths | <code>string</code> | <code>&quot;LastXMonths&quot;</code> | 
| LastXWeeks | <code>string</code> | <code>&quot;LastXWeeks&quot;</code> | 
| LastXYears | <code>string</code> | <code>&quot;LastXYears&quot;</code> | 
| LastYear | <code>string</code> | <code>&quot;LastYear&quot;</code> | 
| LessEqual | <code>string</code> | <code>&quot;LessEqual&quot;</code> | 
| LessThan | <code>string</code> | <code>&quot;LessThan&quot;</code> | 
| Mask | <code>string</code> | <code>&quot;Mask&quot;</code> | 
| MasksSelect | <code>string</code> | <code>&quot;MasksSelect&quot;</code> | 
| Next7Days | <code>string</code> | <code>&quot;Next7Days&quot;</code> | 
| NextFiscalPeriod | <code>string</code> | <code>&quot;NextFiscalPeriod&quot;</code> | 
| NextFiscalYear | <code>string</code> | <code>&quot;NextFiscalYear&quot;</code> | 
| NextMonth | <code>string</code> | <code>&quot;NextMonth&quot;</code> | 
| NextWeek | <code>string</code> | <code>&quot;NextWeek&quot;</code> | 
| NextXDays | <code>string</code> | <code>&quot;NextXDays&quot;</code> | 
| NextXFiscalPeriods | <code>string</code> | <code>&quot;NextXFiscalPeriods&quot;</code> | 
| NextXFiscalYears | <code>string</code> | <code>&quot;NextXFiscalYears&quot;</code> | 
| NextXHours | <code>string</code> | <code>&quot;NextXHours&quot;</code> | 
| NextXMonths | <code>string</code> | <code>&quot;NextXMonths&quot;</code> | 
| NextXWeeks | <code>string</code> | <code>&quot;NextXWeeks&quot;</code> | 
| NextXYears | <code>string</code> | <code>&quot;NextXYears&quot;</code> | 
| NextYear | <code>string</code> | <code>&quot;NextYear&quot;</code> | 
| NotBetween | <code>string</code> | <code>&quot;NotBetween&quot;</code> | 
| NotEqual | <code>string</code> | <code>&quot;NotEqual&quot;</code> | 
| NotEqualBusinessId | <code>string</code> | <code>&quot;NotEqualBusinessId&quot;</code> | 
| NotEqualUserId | <code>string</code> | <code>&quot;NotEqualUserId&quot;</code> | 
| NotIn | <code>string</code> | <code>&quot;NotIn&quot;</code> | 
| NotLike | <code>string</code> | <code>&quot;NotLike&quot;</code> | 
| NotNull | <code>string</code> | <code>&quot;NotNull&quot;</code> | 
| NotOn | <code>string</code> | <code>&quot;NotOn&quot;</code> | 
| Null | <code>string</code> | <code>&quot;Null&quot;</code> | 
| OlderThanXMonths | <code>string</code> | <code>&quot;OlderThanXMonths&quot;</code> | 
| On | <code>string</code> | <code>&quot;On&quot;</code> | 
| OnOrAfter | <code>string</code> | <code>&quot;OnOrAfter&quot;</code> | 
| OnOrBefore | <code>string</code> | <code>&quot;OnOrBefore&quot;</code> | 
| ThisFiscalPeriod | <code>string</code> | <code>&quot;ThisFiscalPeriod&quot;</code> | 
| ThisFiscalYear | <code>string</code> | <code>&quot;ThisFiscalYear&quot;</code> | 
| ThisMonth | <code>string</code> | <code>&quot;ThisMonth&quot;</code> | 
| ThisWeek | <code>string</code> | <code>&quot;ThisWeek&quot;</code> | 
| ThisYear | <code>string</code> | <code>&quot;ThisYear&quot;</code> | 
| Today | <code>string</code> | <code>&quot;Today&quot;</code> | 
| Tomorrow | <code>string</code> | <code>&quot;Tomorrow&quot;</code> | 
| Yesterday | <code>string</code> | <code>&quot;Yesterday&quot;</code> | 
| GreaterEqual | <code>string</code> | <code>&quot;GreaterEqual&quot;</code> | 
| GreaterThan | <code>string</code> | <code>&quot;GreaterThan&quot;</code> | 

<a name="COSA.Const.EntityFilters"></a>
#### Const.EntityFilters : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| Entity | <code>string</code> | <code>&quot;Entity&quot;</code> | 
| Attributes | <code>string</code> | <code>&quot;Attributes&quot;</code> | 
| All | <code>string</code> | <code>&quot;Entity Attributes Privileges Relationships&quot;</code> | 
| Default | <code>string</code> | <code>&quot;Entity&quot;</code> | 
| Privileges | <code>string</code> | <code>&quot;Privileges&quot;</code> | 
| Relationships | <code>string</code> | <code>&quot;Relationships&quot;</code> | 

<a name="COSA.Const.KeyValuePairType"></a>
#### Const.KeyValuePairType : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| StringAnyType | <code>number</code> | <code>0</code> | 
| StringString | <code>number</code> | <code>1</code> | 
| StringAnyTypeWithoutPrefix | <code>number</code> | <code>2</code> | 

<a name="COSA.Const.EntityRole"></a>
#### Const.EntityRole : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| Referenced | <code>number</code> | <code>1</code> | 
| Referencing | <code>number</code> | <code>0</code> | 

<a name="COSA.Const.MetadataConditionOperator"></a>
#### Const.MetadataConditionOperator : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| Equals | <code>string</code> | <code>&quot;Equals&quot;</code> | 
| GreaterThan | <code>string</code> | <code>&quot;GreaterThan&quot;</code> | 
| In | <code>string</code> | <code>&quot;In&quot;</code> | 
| LessThan | <code>string</code> | <code>&quot;LessThan&quot;</code> | 
| NotEquals | <code>string</code> | <code>&quot;NotEquals&quot;</code> | 
| NotIn | <code>string</code> | <code>&quot;NotIn&quot;</code> | 

<a name="COSA.Const.DeletedMetadataFilters"></a>
#### Const.DeletedMetadataFilters : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| All | <code>string</code> | <code>&quot;All&quot;</code> | 
| Attribute | <code>string</code> | <code>&quot;Attribute&quot;</code> | 
| Default | <code>string</code> | <code>&quot;Default&quot;</code> | 
| Entity | <code>string</code> | <code>&quot;Entity&quot;</code> | 
| Label | <code>string</code> | <code>&quot;Label&quot;</code> | 
| OptionSet | <code>string</code> | <code>&quot;OptionSet&quot;</code> | 
| Relationship | <code>string</code> | <code>&quot;Relationship&quot;</code> | 

<a name="COSA.Const.AttributeRequiredLevel"></a>
#### Const.AttributeRequiredLevel : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| ApplicationRequired | <code>string</code> | <code>&quot;ApplicationRequired&quot;</code> | 
| None | <code>string</code> | <code>&quot;None&quot;</code> | 
| Recommended | <code>string</code> | <code>&quot;Recommended&quot;</code> | 
| SystemRequired | <code>string</code> | <code>&quot;SystemRequired&quot;</code> | 

<a name="COSA.Const.DateTimeFormat"></a>
#### Const.DateTimeFormat : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| DateAndTime | <code>string</code> | <code>&quot;DateAndTime&quot;</code> | 
| DateOnly | <code>string</code> | <code>&quot;DateOnly&quot;</code> | 

<a name="COSA.Const.ImeMode"></a>
#### Const.ImeMode : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| Active | <code>string</code> | <code>&quot;Active&quot;</code> | 
| Auto | <code>string</code> | <code>&quot;Auto&quot;</code> | 
| Disabled | <code>string</code> | <code>&quot;Disabled&quot;</code> | 
| Inactive | <code>string</code> | <code>&quot;Inactive&quot;</code> | 

<a name="COSA.Const.IntegerFormat"></a>
#### Const.IntegerFormat : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| Duration | <code>string</code> | <code>&quot;Duration&quot;</code> | 
| Language | <code>string</code> | <code>&quot;Language&quot;</code> | 
| Locale | <code>string</code> | <code>&quot;Locale&quot;</code> | 
| None | <code>string</code> | <code>&quot;None&quot;</code> | 
| TimeZone | <code>string</code> | <code>&quot;TimeZone&quot;</code> | 

<a name="COSA.Const.OwnershipType"></a>
#### Const.OwnershipType : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| BusinessOwned | <code>string</code> | <code>&quot;BusinessOwned&quot;</code> | 
| BusinessParented | <code>string</code> | <code>&quot;BusinessParented&quot;</code> | 
| None | <code>string</code> | <code>&quot;None&quot;</code> | 
| OrganizationOwned | <code>string</code> | <code>&quot;OrganizationOwned&quot;</code> | 
| TeamOwned | <code>string</code> | <code>&quot;TeamOwned&quot;</code> | 
| UserOwned | <code>string</code> | <code>&quot;UserOwned&quot;</code> | 

<a name="COSA.Const.RelationshipType"></a>
#### Const.RelationshipType : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| Default | <code>string</code> | <code>&quot;Default&quot;</code> | 
| ManyToManyRelationship | <code>string</code> | <code>&quot;ManyToManyRelationship&quot;</code> | 
| OneToManyRelationship | <code>string</code> | <code>&quot;OneToManyRelationship&quot;</code> | 

<a name="COSA.Const.StringFormat"></a>
#### Const.StringFormat : <code>enum</code>
**Kind**: static enum property of <code>[Const](#COSA.Const)</code>  
**Properties**

| Name | Type | Default |
| --- | --- | --- |
| Email | <code>string</code> | <code>&quot;Email&quot;</code> | 
| Phone | <code>string</code> | <code>&quot;Phone&quot;</code> | 
| PhoneticGuide | <code>string</code> | <code>&quot;PhoneticGuide&quot;</code> | 
| Text | <code>string</code> | <code>&quot;Text&quot;</code> | 
| TextArea | <code>string</code> | <code>&quot;TextArea&quot;</code> | 
| TickerSymbol | <code>string</code> | <code>&quot;TickerSymbol&quot;</code> | 
| Url | <code>string</code> | <code>&quot;Url&quot;</code> | 
| VersionNumber | <code>string</code> | <code>&quot;VersionNumber&quot;</code> | 

<a name="COSA.Response"></a>
### COSA.Response : <code>object</code>
**Kind**: static namespace of <code>[COSA](#COSA)</code>  

* [.Response](#COSA.Response) : <code>object</code>
    * [.ExecuteWorkflow](#COSA.Response.ExecuteWorkflow)
    * [.Assign](#COSA.Response.Assign)
    * [.SetState](#COSA.Response.SetState)
    * [.LoseOpportunity](#COSA.Response.LoseOpportunity)
    * [.WinOpportunity](#COSA.Response.WinOpportunity)
    * [.AddListMembersList](#COSA.Response.AddListMembersList)
    * [.AddMemberList](#COSA.Response.AddMemberList)
    * [.CopyMembersList](#COSA.Response.CopyMembersList)
    * [.RemoveMemberList](#COSA.Response.RemoveMemberList)
    * [.RetrieveUserPrivileges](#COSA.Response.RetrieveUserPrivileges)
    * [.RetrievePrincipalAccess](#COSA.Response.RetrievePrincipalAccess)
    * [.QualifyLead](#COSA.Response.QualifyLead)
    * [.Retrieve](#COSA.Response.Retrieve)
    * [.RetrieveMultiple](#COSA.Response.RetrieveMultiple)
    * [.Create](#COSA.Response.Create)
    * [.Update](#COSA.Response.Update)
    * [.ExecuteMultiple](#COSA.Response.ExecuteMultiple)
    * [.Delete](#COSA.Response.Delete)
    * [.Associate](#COSA.Response.Associate)
    * [.Disassociate](#COSA.Response.Disassociate)
    * [.RetrieveAttribute](#COSA.Response.RetrieveAttribute)
    * [.RetrieveEntity](#COSA.Response.RetrieveEntity)
    * [.RetrieveAllEntities](#COSA.Response.RetrieveAllEntities)
    * [.RetrieveMetadataChanges](#COSA.Response.RetrieveMetadataChanges)

<a name="COSA.Response.ExecuteWorkflow"></a>
#### Response.ExecuteWorkflow
Execute workflow

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | Process Session unique identifier (GUID) |

<a name="COSA.Response.Assign"></a>
#### Response.Assign
Assign response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
<a name="COSA.Response.SetState"></a>
#### Response.SetState
SetState response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
<a name="COSA.Response.LoseOpportunity"></a>
#### Response.LoseOpportunity
LoseOpportunity response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
<a name="COSA.Response.WinOpportunity"></a>
#### Response.WinOpportunity
WinOpportunity response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
<a name="COSA.Response.AddListMembersList"></a>
#### Response.AddListMembersList
AddListMembersList response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
<a name="COSA.Response.AddMemberList"></a>
#### Response.AddMemberList
AddMemberList response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| Unique | <code>string</code> | identifier (GUID) |

<a name="COSA.Response.CopyMembersList"></a>
#### Response.CopyMembersList
CopyMembersList response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
<a name="COSA.Response.RemoveMemberList"></a>
#### Response.RemoveMemberList
RemoveMemberList response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
<a name="COSA.Response.RetrieveUserPrivileges"></a>
#### Response.RetrieveUserPrivileges
RetrieveUserPrivileges response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| rolePrivileges | <code>string</code> | Role privileges |

<a name="COSA.Response.RetrievePrincipalAccess"></a>
#### Response.RetrievePrincipalAccess
RetrievePrincipalAccess response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| accessRights | <code>string</code> | Access Rights |

<a name="COSA.Response.QualifyLead"></a>
#### Response.QualifyLead
QualifyLead response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
**Properties**

| Name |
| --- |
| createdEntities | 

<a name="COSA.Response.Retrieve"></a>
#### Response.Retrieve
Retrieve response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| entity | <code>[BusinessEntity](#COSA.BusinessEntity)</code> | Entity |

<a name="COSA.Response.RetrieveMultiple"></a>
#### Response.RetrieveMultiple
RetrieveMultiple response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| entities | <code>[EntityCollection](#COSA.EntityCollection)</code> | Entities |

<a name="COSA.Response.Create"></a>
#### Response.Create
Create response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | Created entity unique identifier (GUID) |

<a name="COSA.Response.Update"></a>
#### Response.Update
Update response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
<a name="COSA.Response.ExecuteMultiple"></a>
#### Response.ExecuteMultiple
ExecuteMultiple response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  

| Param | Description |
| --- | --- |
| initialRequest | Initial request |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| initialRequests |  | Requests |
| responses | <code>COSA.ResponseCollection</code> | Responses |

<a name="COSA.Response.Delete"></a>
#### Response.Delete
Delete response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
<a name="COSA.Response.Associate"></a>
#### Response.Associate
Associate response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
<a name="COSA.Response.Disassociate"></a>
#### Response.Disassociate
Disassociate response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
<a name="COSA.Response.RetrieveAttribute"></a>
#### Response.RetrieveAttribute
RetrieveAttribute response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| attributeMetadata | <code>COSA.AttributeMetadata</code> | Attribute metadata |

<a name="COSA.Response.RetrieveEntity"></a>
#### Response.RetrieveEntity
RetrieveEntity response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| entityMetadata | <code>COSA.EntityMetadata</code> | Entity Metadata |

<a name="COSA.Response.RetrieveAllEntities"></a>
#### Response.RetrieveAllEntities
RetrieveAllEntities response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| entityMetadata | <code>COSA.EntityMetadata</code> | Entity Metadata |
| timestamp | <code>string</code> | Timestamp |

<a name="COSA.Response.RetrieveMetadataChanges"></a>
#### Response.RetrieveMetadataChanges
RetrieveMetadataChanges response

**Kind**: static class of <code>[Response](#COSA.Response)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| entityMetadata | <code>COSA.EntityMetadata</code> | Entity Metadata |
| deletedMetadata |  | Deleted metadata |
| serverVersionStamp | <code>string</code> | Server version stamp |

<a name="COSA.Request"></a>
### COSA.Request : <code>object</code>
**Kind**: static namespace of <code>[COSA](#COSA)</code>  

* [.Request](#COSA.Request) : <code>object</code>
    * [.ExecuteWorkflow](#COSA.Request.ExecuteWorkflow)
    * [.Assign](#COSA.Request.Assign)
    * [.SetState](#COSA.Request.SetState)
    * [.RetrieveUserPrivileges](#COSA.Request.RetrieveUserPrivileges)
    * [.RetrievePrincipalAccess](#COSA.Request.RetrievePrincipalAccess)
    * [.LoseOpportunity](#COSA.Request.LoseOpportunity)
    * [.WinOpportunity](#COSA.Request.WinOpportunity)
    * [.QualifyLead](#COSA.Request.QualifyLead)
    * [.AddListMembersList](#COSA.Request.AddListMembersList)
    * [.AddMemberList](#COSA.Request.AddMemberList)
    * [.CopyMembersList](#COSA.Request.CopyMembersList)
    * [.RemoveMemberList](#COSA.Request.RemoveMemberList)
    * [.Retrieve](#COSA.Request.Retrieve)
    * [.Create](#COSA.Request.Create)
    * [.Update](#COSA.Request.Update)
    * [.Delete](#COSA.Request.Delete)
    * [.ExecuteMultiple](#COSA.Request.ExecuteMultiple)
    * [.RetrieveMultiple](#COSA.Request.RetrieveMultiple)
    * [.RetrieveAttribute](#COSA.Request.RetrieveAttribute)
    * [.RetrieveEntity](#COSA.Request.RetrieveEntity)
    * [.RetrieveAllEntities](#COSA.Request.RetrieveAllEntities)
    * [.Associate](#COSA.Request.Associate)
    * [.Disassociate](#COSA.Request.Disassociate)
    * [.RetrieveMetadataChanges](#COSA.Request.RetrieveMetadataChanges)

<a name="COSA.Request.ExecuteWorkflow"></a>
#### Request.ExecuteWorkflow
ExecuteWorkflow message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| workflowId | <code>string</code> | Workflow unique identifier (GUID) |
| entityId | <code>string</code> | Entity unique identifier (GUID) |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| workflowId | <code>string</code> | Workflow unique identifier (GUID) |
| entityId | <code>string</code> | Entity unique identifier (GUID) |
| requestId | <code>string</code> | Request unique identifier (GUID) |

<a name="COSA.Request.Assign"></a>
#### Request.Assign
Assign message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| target | <code>[EntityReference](#COSA.EntityReference)</code> | Target |
| assignee | <code>[EntityReference](#COSA.EntityReference)</code> | Assignee |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| target | <code>[EntityReference](#COSA.EntityReference)</code> | Target |
| assignee | <code>[EntityReference](#COSA.EntityReference)</code> | Assignee |

<a name="COSA.Request.SetState"></a>
#### Request.SetState
SetState message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| entityMoniker | <code>[EntityReference](#COSA.EntityReference)</code> | Entity Moniker |
| state | <code>number</code> | State |
| status | <code>number</code> | Status |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| entityMoniker | <code>[EntityReference](#COSA.EntityReference)</code> | Entity Moniker |
| state | <code>number</code> | State |
| status | <code>number</code> | Status |

<a name="COSA.Request.RetrieveUserPrivileges"></a>
#### Request.RetrieveUserPrivileges
RetrieveUserPrivileges message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| userId | <code>string</code> | User unique identifier (GUID) |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| userId | <code>string</code> | User unique identifier (GUID) |

<a name="COSA.Request.RetrievePrincipalAccess"></a>
#### Request.RetrievePrincipalAccess
RetrievePrincipalAccess message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| principal | <code>[EntityReference](#COSA.EntityReference)</code> | Principal |
| target | <code>[EntityReference](#COSA.EntityReference)</code> | Target |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| principal | <code>[EntityReference](#COSA.EntityReference)</code> | Principal |
| target | <code>[EntityReference](#COSA.EntityReference)</code> | Target |

<a name="COSA.Request.LoseOpportunity"></a>
#### Request.LoseOpportunity
LoseOpportunity message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| opportunityClose | <code>[BusinessEntity](#COSA.BusinessEntity)</code> | Opportunity Close Entity |
| status | <code>[OptionSetValue](#COSA.OptionSetValue)</code> | Status |
| requestId | <code>string</code> | Request Unique Identifier |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| opportunityClose | <code>[BusinessEntity](#COSA.BusinessEntity)</code> | Opportunity Close Entity |
| status | <code>[OptionSetValue](#COSA.OptionSetValue)</code> | Status |

<a name="COSA.Request.WinOpportunity"></a>
#### Request.WinOpportunity
WinOpportunity message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| opportunityClose | <code>[BusinessEntity](#COSA.BusinessEntity)</code> | Opportunity Close Entity |
| status | <code>number</code> | Opportunity Status |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| opportunityClose | <code>[BusinessEntity](#COSA.BusinessEntity)</code> | Opportunity Close Entity |
| status | <code>number</code> | Opportunity Status |

<a name="COSA.Request.QualifyLead"></a>
#### Request.QualifyLead
QualifyLead message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| lead | <code>[EntityReference](#COSA.EntityReference)</code> | Lead |
| createAccount | <code>boolean</code> | Create Account |
| createContact | <code>boolean</code> | Create Contact |
| createOpportunity | <code>boolean</code> | Create Opportunity |
| status | <code>number</code> | Lead Status |
| requestId | <code>string</code> | Request Unique Identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| lead | <code>[EntityReference](#COSA.EntityReference)</code> | Lead |
| createAccount | <code>boolean</code> | Create Account |
| createContact | <code>boolean</code> | Create Contact |
| createOpportunity | <code>boolean</code> | Create Opportunity |
| status | <code>number</code> | Lead Status |
| sourceCampaignId | <code>string</code> | Source Campaign unique identifier (GUID) |
| opportunityCurrencyId | <code>string</code> | Opportunity Currency unique identifier (GUID) |
| opportunityCustomerId | <code>string</code> | Opportunity Customer unique identifier (GUID) |

<a name="COSA.Request.AddListMembersList"></a>
#### Request.AddListMembersList
AddListMembersList message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| listId | <code>string</code> | List unique identifier (GUID) |
| memberIds | <code>Array.&lt;string&gt;</code> | Members unique identifiers (GUID) |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| listId | <code>string</code> | List unique identifier (GUID) |
| memberIds | <code>Array.&lt;string&gt;</code> | Members unique identifiers (GUID) |

<a name="COSA.Request.AddMemberList"></a>
#### Request.AddMemberList
AddMemberList message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| listId | <code>string</code> | List unique identifier (GUID) |
| entityId | <code>string</code> | Entity unique identifier (GUID) |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| listId | <code>string</code> | List unique identifier (GUID) |
| entityId | <code>string</code> | Entity unique identifier (GUID) |

<a name="COSA.Request.CopyMembersList"></a>
#### Request.CopyMembersList
CopyMembersList message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| sourceListId | <code>string</code> | Source List unique identifier (GUID) |
| targetListId | <code>string</code> | Target List unique identifier (GUID) |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| sourceListId | <code>string</code> | Source List unique identifier (GUID) |
| targetListId | <code>string</code> | Target List unique identifier (GUID) |

<a name="COSA.Request.RemoveMemberList"></a>
#### Request.RemoveMemberList
RemoveMemberList message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| listId | <code>string</code> | List unique identifier (GUID) |
| entityId | <code>string</code> | Entity unique identifier (GUID) |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| entityId | <code>string</code> | Entity unique identifier (GUID) |
| requestId | <code>string</code> | Request unique identifier (GUID) |

<a name="COSA.Request.Retrieve"></a>
#### Request.Retrieve
Retrieve message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| logicalName | <code>string</code> | Entity Logical Name |
| id | <code>string</code> | Entity Unique Identifier |
| columnSet | <code>Array.&lt;string&gt;</code> | Requested columns |
| requestId | <code>string</code> | Unique Request Identifier |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| logicalName | <code>string</code> | Entity Logical Name |
| id | <code>string</code> | Entity Unique Identifier |
| columnSet | <code>Array.&lt;string&gt;</code> | Requested columns |
| requestId | <code>string</code> | Unique Request Identifier |

<a name="COSA.Request.Create"></a>
#### Request.Create
Create message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| entity | <code>BusinessEntity</code> | Entity to create |
| requestId | <code>string</code> | Request unique identifier |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| entity | <code>BusinessEntity</code> | Entity to create |

<a name="COSA.Request.Update"></a>
#### Request.Update
Update message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| entity | <code>BusinessEntity</code> | Entity to update |
| requestId | <code>string</code> | Guid-like string as Request unique identifier |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| entity | <code>BusinessEntity</code> | Entity |

<a name="COSA.Request.Delete"></a>
#### Request.Delete
Delete message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| logicalName | <code>string</code> | Entity logical name |
| id | <code>string</code> | Guid-like string as Entity unique identifier |
| requestId | <code>string</code> | Guid-like string as Request unique identifier |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| logicalName | <code>string</code> | Entity logical name |
| id | <code>string</code> | Guid-like string as Entity unique identifier |
| requestId | <code>string</code> | Guid-like string as Request unique identifier |

**Example**  
```js
(new COSA.Request.Delete('contact', 'F396628A-2926-E511-9430-005056B8429A')).execute(function ( r ) {       //Working with a response   });
```
<a name="COSA.Request.ExecuteMultiple"></a>
#### Request.ExecuteMultiple
ExecuteMultiple message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| requests | <code>OrganizationRequestCollection</code> | Requests collection |
| settings | <code>ExecuteMultipleSettings</code> |  |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type |
| --- | --- |
| requests | <code>OrganizationRequestCollection</code> | 
| settings | <code>ExecuteMultipleSettings</code> | 

**Example**  
```js
var be_0 = new COSA.BusinessEntity("contact", null, { firstname: 'Michael', lastname: 'Jackson', primaryemail:'mjackson@mail.com'}),    createRq = new COSA.Request.Create(be_0),    deleteRq = new COSA.Request.Delete('contact', 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'),    execMultRqs = new COSA.OrganizationRequestCollection([createRq, deleteRq]),    execMultSett = new COSA.ExecuteMultipleSettings(true, false),    execMultRq = new COSA.Request.ExecuteMultiple(execMultRqs, execMultSett);execMultRq.execute(callbackFunc);//orCOSA.Core.Execute(execMultRq, callbackFunc);
```
<a name="COSA.Request.RetrieveMultiple"></a>
#### Request.RetrieveMultiple
RetrieveMultiple message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| queryExpression | <code>[QueryExpression](#COSA.QueryExpression)</code> | Query Expression object |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| queryExpression | <code>[QueryExpression](#COSA.QueryExpression)</code> | Query Expression object |

<a name="COSA.Request.RetrieveAttribute"></a>
#### Request.RetrieveAttribute
RetrieveAttribute message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| entityLogicalName | <code>string</code> | Entity Logical Name |
| attrLogicalName | <code>string</code> | Attribute LogicalName |
| retrieveAsIfPublished | <code>boolean</code> | Retrieve As If Published |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| entityLogicalName | <code>string</code> | Entity Logical Name |
| attributeLogicalName | <code>string</code> | Attribute Logical Name |
| retrieveAsIfPublished | <code>boolean</code> | Retrieve As If Published |

<a name="COSA.Request.RetrieveEntity"></a>
#### Request.RetrieveEntity
RetrieveEntity message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| logicalName | <code>string</code> | Entity logical name |
| filters | <code>[EntityFilters](#COSA.EntityFilters)</code> | Entity filters |
| retrieveAsIfPublished | <code>boolean</code> | Retrieve As If Published |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| logicalName | <code>string</code> | Entity Logical Name |
| entityFilters | <code>[EntityFilters](#COSA.EntityFilters)</code> | EntityFilters |
| retrieveAsIfPublished | <code>boolean</code> | Retrieve As If Published |

<a name="COSA.Request.RetrieveAllEntities"></a>
#### Request.RetrieveAllEntities
RetrieveAllEntities message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| filters | <code>[EntityFilters](#COSA.EntityFilters)</code> | Entity Filters |
| retrieveAsIfPublished | <code>boolean</code> | Retrieve As If Published |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| entityFilters | <code>[EntityFilters](#COSA.EntityFilters)</code> | EntityFilters |
| retrieveAsIfPublished | <code>boolean</code> | Retrieve As If Published |

<a name="COSA.Request.Associate"></a>
#### Request.Associate
Associate message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| relationshipSchemaName | <code>string</code> | Relationship Schema Name |
| target | <code>[EntityReference](#COSA.EntityReference)</code> | Target |
| relatedEntities | <code>COSA.EntityReferenceCollection</code> | Related Entities Collection |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| relationshipSchemaName | <code>string</code> | Relationship Schema Name |
| target | <code>[EntityReference](#COSA.EntityReference)</code> | Target |
| relatedEntities | <code>COSA.EntityReferenceCollection</code> | Related Entities |

<a name="COSA.Request.Disassociate"></a>
#### Request.Disassociate
Disassociate message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| relationshipSchemaName | <code>string</code> | RelationshipSchemaName |
| target | <code>[EntityReference](#COSA.EntityReference)</code> | Target |
| relatedEntities | <code>COSA.EntityReferenceCollection</code> | Related Entities |
| requestId | <code>string</code> | Request unique identifier (GUID) |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| relationshipSchemaName | <code>string</code> | RelationshipSchemaName |
| target | <code>[EntityReference](#COSA.EntityReference)</code> | Target |
| relatedEntities | <code>COSA.EntityReferenceCollection</code> | Related Entities |

<a name="COSA.Request.RetrieveMetadataChanges"></a>
#### Request.RetrieveMetadataChanges
RetrieveMetadataChanges message

**Kind**: static class of <code>[Request](#COSA.Request)</code>  

| Param | Type | Description |
| --- | --- | --- |
| query | <code>COSA.MetadataFilterExpression</code> | Query |
| clientVersionStamp | <code>string</code> | Client Version Stamp |
| deletedMetadataFilters | <code>[DeletedMetadataFilters](#COSA.DeletedMetadataFilters)</code> | Deleted Metadata Filters |
| requestId |  |  |

**Properties**

| Name | Type | Description |
| --- | --- | --- |
| query | <code>COSA.MetadataFilterExpression</code> | Query |
| clientVersionStamp | <code>string</code> | Client Version Stamp |
| deletedMetadataFilters | <code>[DeletedMetadataFilters](#COSA.DeletedMetadataFilters)</code> | Deleted Metadata Filters |

